<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Channel functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__hppass__sar__chan.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Channel functions<div class="ingroups"><a class="el" href="group__group__hppass.html">HPPASS       (High Performance Programmable Analog Sub-System)</a> &raquo; <a class="el" href="group__group__hppass__sar.html">SAR (Successive-Approximation Register Analogue to Digital Converter)</a> &raquo; <a class="el" href="group__group__hppass__sar__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga9a7d494c034e66c8000dfb3ebbe35234"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#ga9a7d494c034e66c8000dfb3ebbe35234">Cy_HPPASS_SAR_ChannelConfig</a> (uint8_t chanIdx, const <a class="el" href="structcy__stc__hppass__sar__chan__t.html">cy_stc_hppass_sar_chan_t</a> *chanCfg)</td></tr>
<tr class="memdesc:ga9a7d494c034e66c8000dfb3ebbe35234"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the ADC channel.  <a href="#ga9a7d494c034e66c8000dfb3ebbe35234">More...</a><br /></td></tr>
<tr class="separator:ga9a7d494c034e66c8000dfb3ebbe35234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b792b9cec8590690005a53761d113bd"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#ga3b792b9cec8590690005a53761d113bd">Cy_HPPASS_SAR_Result_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga3b792b9cec8590690005a53761d113bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the combined status of all the ADC channels and FIRs results.  <a href="#ga3b792b9cec8590690005a53761d113bd">More...</a><br /></td></tr>
<tr class="separator:ga3b792b9cec8590690005a53761d113bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93f5945aa2e1d6df0ee65123870b17e5"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#ga93f5945aa2e1d6df0ee65123870b17e5">Cy_HPPASS_SAR_Result_ClearStatus</a> (uint32_t mask)</td></tr>
<tr class="memdesc:ga93f5945aa2e1d6df0ee65123870b17e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all the ADC channels and FIRs results status.  <a href="#ga93f5945aa2e1d6df0ee65123870b17e5">More...</a><br /></td></tr>
<tr class="separator:ga93f5945aa2e1d6df0ee65123870b17e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea7bbb3947dc53f845f8f4955d678187"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#gaea7bbb3947dc53f845f8f4955d678187">Cy_HPPASS_SAR_Result_ChannelRead</a> (uint8_t chanIdx)</td></tr>
<tr class="memdesc:gaea7bbb3947dc53f845f8f4955d678187"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the ADC channel results.  <a href="#gaea7bbb3947dc53f845f8f4955d678187">More...</a><br /></td></tr>
<tr class="separator:gaea7bbb3947dc53f845f8f4955d678187"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga990ed5ee57984e74be3fc4a8e352c2cc"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#ga990ed5ee57984e74be3fc4a8e352c2cc">Cy_HPPASS_SAR_Result_ChannelPackedRead</a> (uint8_t pairIdx)</td></tr>
<tr class="memdesc:ga990ed5ee57984e74be3fc4a8e352c2cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the specified adjacent even/odd channel results from the channel result packed register.  <a href="#ga990ed5ee57984e74be3fc4a8e352c2cc">More...</a><br /></td></tr>
<tr class="separator:ga990ed5ee57984e74be3fc4a8e352c2cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0843ba2129a83e71cd02fbf302f62581"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#ga0843ba2129a83e71cd02fbf302f62581">Cy_HPPASS_SAR_Result_GetOverflowStatus</a> (void)</td></tr>
<tr class="memdesc:ga0843ba2129a83e71cd02fbf302f62581"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the ADC groups and FIRs result overflow status.  <a href="#ga0843ba2129a83e71cd02fbf302f62581">More...</a><br /></td></tr>
<tr class="separator:ga0843ba2129a83e71cd02fbf302f62581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3d64eb4f8923ae80c75194b15d303c7c"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#ga3d64eb4f8923ae80c75194b15d303c7c">Cy_HPPASS_SAR_Result_ClearOverflowStatus</a> (uint32_t mask)</td></tr>
<tr class="memdesc:ga3d64eb4f8923ae80c75194b15d303c7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the ADC groups and FIRs result overflow status.  <a href="#ga3d64eb4f8923ae80c75194b15d303c7c">More...</a><br /></td></tr>
<tr class="separator:ga3d64eb4f8923ae80c75194b15d303c7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga58600d4d33896b9957a5414048ed1c6a"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#ga58600d4d33896b9957a5414048ed1c6a">Cy_HPPASS_SAR_Limit_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga58600d4d33896b9957a5414048ed1c6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the combined limit crossing detection status of all the ADC and FIR channels.  <a href="#ga58600d4d33896b9957a5414048ed1c6a">More...</a><br /></td></tr>
<tr class="separator:ga58600d4d33896b9957a5414048ed1c6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1c4d6700a7269642e39e60ca87272d64"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__sar__chan.html#ga1c4d6700a7269642e39e60ca87272d64">Cy_HPPASS_SAR_Limit_ClearStatus</a> (uint32_t mask)</td></tr>
<tr class="memdesc:ga1c4d6700a7269642e39e60ca87272d64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the limit crossing detection status for all the ADC and FIR channels.  <a href="#ga1c4d6700a7269642e39e60ca87272d64">More...</a><br /></td></tr>
<tr class="separator:ga1c4d6700a7269642e39e60ca87272d64"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9a7d494c034e66c8000dfb3ebbe35234"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a7d494c034e66c8000dfb3ebbe35234">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_ChannelConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a> Cy_HPPASS_SAR_ChannelConfig </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>chanIdx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcy__stc__hppass__sar__chan__t.html">cy_stc_hppass_sar_chan_t</a> *&#160;</td>
          <td class="paramname"><em>chanCfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the ADC channel. </p>
<dl class="section note"><dt>Note</dt><dd>If AC is running this configuration is not allowed (<a class="el" href="group__group__hppass__enums.html#gga14c32a49b351302efcaf56b2e5075e00a7f6c5e025421582710cadfffcada200c">CY_HPPASS_AC_INVALID_STATE</a> will be returned).</dd>
<dd>
If the SAR block is currently busy the initialization is not allowed (<a class="el" href="group__group__hppass__enums.html#gga14c32a49b351302efcaf56b2e5075e00a1b8592bb519e24c005a10ee1d49a8c58">CY_HPPASS_SAR_INVALID_STATE</a> will be returned).</dd>
<dd>
Since the 'block ready' status is combined SAR and CSG, this particular SAR function cannot be protected from reinitialization during the 'block ready' == true condition, so it is on user's responsibility when and from where to call this function to reconfigure this SAR sub-block.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">chanIdx</td><td>The index of the channel. Valid range 0..27.</td></tr>
    <tr><td class="paramname">chanCfg</td><td>Pointer to the channel configuration structure <a class="el" href="structcy__stc__hppass__sar__chan__t.html">cy_stc_hppass_sar_chan_t</a>. The pointer cannot be NULL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status, <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line"><a class="code" href="structcy__stc__hppass__sar__chan__t.html">cy_stc_hppass_sar_chan_t</a> chanCfg =</div><div class="line">{</div><div class="line">    .<a class="code" href="structcy__stc__hppass__sar__chan__t.html#a3cc40a1a5f02a50081870b542d4525b3">diff</a>     = <span class="keyword">false</span>,</div><div class="line">    .sign     = <span class="keyword">false</span>,</div><div class="line">    .avg      = <a class="code" href="group__group__hppass__sar__enums.html#ggae2f7574296597739ca43f2196bab0853a92843786edc02440f371b776a417c973">CY_HPPASS_SAR_AVG_DISABLED</a>,</div><div class="line">    .limit = <a class="code" href="group__group__hppass__sar__enums.html#gga761a8378e0f3b0eab1a27f8617d1c02eae8979b0849935acf47a6057472a8c377">CY_HPPASS_SAR_LIMIT_DISABLED</a>,</div><div class="line">    .result   = <span class="keyword">true</span>,</div><div class="line">    .fifo  = <a class="code" href="group__group__hppass__sar__enums.html#ggaf90fa2a37e0fb7ef39e80b0c8c3179e9a27b52f62b23dd390c0f3317d106ade34">CY_HPPASS_FIFO_DISABLED</a></div><div class="line">};</div></div><!-- fragment -->
</div>
</div>
<a id="ga3b792b9cec8590690005a53761d113bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3b792b9cec8590690005a53761d113bd">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_Result_GetStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Result_GetStatus </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the combined status of all the ADC channels and FIRs results. </p>
<dl class="section return"><dt>Returns</dt><dd>The ADC channels and FIRs results status <a class="el" href="group__group__hppass__sar__status.html">Result Status Masks</a>.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line">    status = <a class="code" href="group__group__hppass__sar__chan.html#ga3b792b9cec8590690005a53761d113bd">Cy_HPPASS_SAR_Result_GetStatus</a>();</div></div><!-- fragment -->
</div>
</div>
<a id="ga93f5945aa2e1d6df0ee65123870b17e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga93f5945aa2e1d6df0ee65123870b17e5">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_Result_ClearStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_HPPASS_SAR_Result_ClearStatus </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>mask</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears all the ADC channels and FIRs results status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">mask</td><td>The channels and FIRs status mask <a class="el" href="group__group__hppass__sar__status.html">Result Status Masks</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line">    <a class="code" href="group__group__hppass__sar__chan.html#ga93f5945aa2e1d6df0ee65123870b17e5">Cy_HPPASS_SAR_Result_ClearStatus</a>(<a class="code" href="group__group__hppass__sar__status.html#ga961dd6a2a2f8656abf16b9e28cfcfbde">CY_HPPASS_SAR_CHAN_0_MSK</a>);</div></div><!-- fragment -->
</div>
</div>
<a id="gaea7bbb3947dc53f845f8f4955d678187"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaea7bbb3947dc53f845f8f4955d678187">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_Result_ChannelRead()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE int16_t Cy_HPPASS_SAR_Result_ChannelRead </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>chanIdx</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the ADC channel results. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">chanIdx</td><td>The index of the channel instance. Valid range 0..27. <a class="el" href="group__group__hppass__sar__chan__idx.html">Channel Indexes</a> except FIR items.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The ADC channels results.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line">            <span class="comment">/* Read channel 0 measurement result */</span></div><div class="line">            printf(<span class="stringliteral">&quot;SAR0 Result: %x     &quot;</span>, <a class="code" href="group__group__hppass__sar__chan.html#gaea7bbb3947dc53f845f8f4955d678187">Cy_HPPASS_SAR_Result_ChannelRead</a>(0));</div><div class="line">            printf(<span class="stringliteral">&quot;SAR12 Result: %x     &quot;</span>, <a class="code" href="group__group__hppass__sar__chan.html#gaea7bbb3947dc53f845f8f4955d678187">Cy_HPPASS_SAR_Result_ChannelRead</a>(12));</div><div class="line">            printf(<span class="stringliteral">&quot;SAR16 Result: %x     &quot;</span>, <a class="code" href="group__group__hppass__sar__chan.html#gaea7bbb3947dc53f845f8f4955d678187">Cy_HPPASS_SAR_Result_ChannelRead</a>(16));</div><div class="line">            printf(<span class="stringliteral">&quot;SAR20 Result: %x     &quot;</span>, <a class="code" href="group__group__hppass__sar__chan.html#gaea7bbb3947dc53f845f8f4955d678187">Cy_HPPASS_SAR_Result_ChannelRead</a>(20));</div><div class="line">            printf(<span class="stringliteral">&quot;SAR24 Result: %x\r\n&quot;</span>, <a class="code" href="group__group__hppass__sar__chan.html#gaea7bbb3947dc53f845f8f4955d678187">Cy_HPPASS_SAR_Result_ChannelRead</a>(24));</div></div><!-- fragment -->
</div>
</div>
<a id="ga990ed5ee57984e74be3fc4a8e352c2cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga990ed5ee57984e74be3fc4a8e352c2cc">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_Result_ChannelPackedRead()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Result_ChannelPackedRead </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>pairIdx</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the specified adjacent even/odd channel results from the channel result packed register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pairIdx</td><td>The index of the adjacent even/odd channels pair instance. Valid range 0..13.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The ADC even (low two bytes) and odd (high two bytes) channels results.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line">    <span class="comment">/* Read results from channels 0 and 1 */</span></div><div class="line">    uint32_t packedResult =  <a class="code" href="group__group__hppass__sar__chan.html#ga990ed5ee57984e74be3fc4a8e352c2cc">Cy_HPPASS_SAR_Result_ChannelPackedRead</a>(0U);</div></div><!-- fragment -->
</div>
</div>
<a id="ga0843ba2129a83e71cd02fbf302f62581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0843ba2129a83e71cd02fbf302f62581">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_Result_GetOverflowStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Result_GetOverflowStatus </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the ADC groups and FIRs result overflow status. </p>
<dl class="section return"><dt>Returns</dt><dd>The ADC groups and FIRs results status <a class="el" href="group__group__hppass__sar__result__interrupts.html">Result Interrupt Masks</a></dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line">    status = <a class="code" href="group__group__hppass__sar__chan.html#ga0843ba2129a83e71cd02fbf302f62581">Cy_HPPASS_SAR_Result_GetOverflowStatus</a>();</div></div><!-- fragment -->
</div>
</div>
<a id="ga3d64eb4f8923ae80c75194b15d303c7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3d64eb4f8923ae80c75194b15d303c7c">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_Result_ClearOverflowStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_HPPASS_SAR_Result_ClearOverflowStatus </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>mask</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears the ADC groups and FIRs result overflow status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">mask</td><td>The groups and FIRs result overflow status mask <a class="el" href="group__group__hppass__sar__result__interrupts.html">Result Interrupt Masks</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line">    <a class="code" href="group__group__hppass__sar__chan.html#ga3d64eb4f8923ae80c75194b15d303c7c">Cy_HPPASS_SAR_Result_ClearOverflowStatus</a>(<a class="code" href="group__group__hppass__sar__result__interrupts.html#ga97c54477e00ecb84169c222c10038d14">CY_HPPASS_INTR_SAR_RESULT_FIR_0</a>);</div></div><!-- fragment -->
</div>
</div>
<a id="ga58600d4d33896b9957a5414048ed1c6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga58600d4d33896b9957a5414048ed1c6a">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_Limit_GetStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Limit_GetStatus </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the combined limit crossing detection status of all the ADC and FIR channels. </p>
<dl class="section return"><dt>Returns</dt><dd>The limit crossing detection status <a class="el" href="group__group__hppass__sar__status.html">Result Status Masks</a></dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line">    <span class="comment">/* Check for limit crossing */</span></div><div class="line">    <span class="comment">/* Scenario: Get combined limit crossing detection status of all the ADC and FIR channels */</span></div><div class="line">    <span class="keywordflow">if</span> (0UL != <a class="code" href="group__group__hppass__sar__chan.html#ga58600d4d33896b9957a5414048ed1c6a">Cy_HPPASS_SAR_Limit_GetStatus</a>())</div><div class="line">    {</div><div class="line">        <span class="comment">/* Process limit crossing case */</span></div><div class="line">    }</div></div><!-- fragment -->
</div>
</div>
<a id="ga1c4d6700a7269642e39e60ca87272d64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c4d6700a7269642e39e60ca87272d64">&#9670;&nbsp;</a></span>Cy_HPPASS_SAR_Limit_ClearStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_HPPASS_SAR_Limit_ClearStatus </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>mask</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears the limit crossing detection status for all the ADC and FIR channels. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">mask</td><td>The limit crossing detection status mask <a class="el" href="group__group__hppass__sar__status.html">Result Status Masks</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Function Usage</dt><dd></dd></dl>
<div class="fragment"><div class="line">        <span class="comment">/* Clear the limit crossing detection status for all the ADC and FIR channels */</span></div><div class="line">        <a class="code" href="group__group__hppass__sar__chan.html#ga1c4d6700a7269642e39e60ca87272d64">Cy_HPPASS_SAR_Limit_ClearStatus</a>(<a class="code" href="group__group__hppass__sar__status.html#ga546ed5df60ba2742f6f09d6ce3f5ca90">CY_HPPASS_SAR_CHAN_MSK</a>);</div></div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
